docs: add axi-axi to community catalog - #113
Conversation
Add axi-axi to the community list in catalog.yaml and regenerate README.md and docs/index.html with pnpm run docs:gen. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
|
Speaking as Kun's firstmate: I reviewed the diff ( Independent source review at pin
Catalog description (scaffold a compliant AXI, read the 10 principles, read-only compliance checks) is source-backed at this pin ( VISION.md per-rule:
Diff is catalog-only; no security issue. Fork CI is green. The PR is CONFLICTING with main; I will resolve and land if the fork can be updated. |
kunchenguid
left a comment
There was a problem hiding this comment.
Speaking as Kun's firstmate: catalog-only diff, no security issue. Package admitted at the inspected pin (see comment).
|
Speaking as Kun's firstmate. This catalog entry landed via last-resort port #158 (squash merge |
Intent
Add the axi-axi package (https://github.com/CodyEngel/axi-axi) to the AXI community catalog so it shows up in the generated README.md and axi.md catalog tables.
What Changed
axi-axientry (authorCodyEngel, domain "AXI authoring") to thecommunitysection ofcatalog.yaml, the single source for the AXI catalog.generated:catalog-communityregions ofREADME.mdanddocs/index.htmlso the new row appears in both the README table and the axi.md site table.Risk Assessment
✅ Low: A three-file, docs-only catalog addition that follows the documented contributor workflow exactly, with generated regions consistent with what the generator would emit and no source-verifiable defects.
Testing
I exercised the catalog change on all three surfaces it touches. The docs:check CI gate passes, meaning the committed README.md and docs/index.html tables are byte-exact regenerations of catalog.yaml; a negative test (dropping the axi-axi entry) made that same check fail on both files, proving the rows are genuinely generated from the new entry rather than hand-typed, and the worktree was left clean after restoring. I then served docs/ locally and screenshotted the real axi.md page, showing axi-axi as the final community-catalog row with the correct author, domain, description, and a link to github.com/CodyEngel/axi-axi (which returns HTTP 200). README.md has no rendered screenshot because its end-user surface is GitHub's own markdown renderer, which isn't reproducible offline without sending content to an external API; the identical catalog data is shown rendered in the axi.md screenshots, and the README row is verified through its generated table region plus the byte-exact docs:check gate. Everything passed with no issues found.
/var/folders/h0/hd2bmc2524z2fz14zcl1p4400000gn/T/no-mistakes-evidence/01KY8K1RATY258V0NX239V9WWG/axi-md-community-table-full.png)/var/folders/h0/hd2bmc2524z2fz14zcl1p4400000gn/T/no-mistakes-evidence/01KY8K1RATY258V0NX239V9WWG/axi-md-community-catalog.png)/var/folders/h0/hd2bmc2524z2fz14zcl1p4400000gn/T/no-mistakes-evidence/01KY8K1RATY258V0NX239V9WWG/axi-md-catalog-full-table.png)Evidence: docs:check gate, drift negative test, generated README row, and link reachability
$ pnpm run docs:check docs:check ok — generated regions match their sources # --- Negative test: temporarily drop the axi-axi entry from catalog.yaml --- error: README.md is out of sync with catalog.yaml/principles.yaml error: docs/index.html is out of sync with catalog.yaml/principles.yaml exit code 1 -> both tables really are generated from the catalog entry (restored afterwards; git status clean) # --- README.md community catalog table (generated region) --- |axi-axi| CodyEngel | AXI authoring | Scaffold a compliant AXI, read the 10 principles in token-tuned slices, and run read-only compliance checks against a candidate CLI. | # --- catalog link reachability --- GET https://github.com/CodyEngel/axi-axi -> HTTP 200Pipeline
Updates from git push no-mistakes
✅ **intent** - passed
✅ No issues found.
✅ **Rebase** - passed
✅ No issues found.
catalog.yaml:154- VISION.md's catalog policy requires an independent maintainer source review of the package at an exact pinned revision or release before a positive admission verdict, and names existence checks and contributor-provided claims as insufficient evidence. This diff review verified only that the entry is well-formed, the repo exists and is public, and the catalog text matches the package's own README — that does not satisfy the policy. No change to the diff is needed; the pinned-source review is maintainer-owned.✅ **Test** - passed
✅ No issues found.
pnpm install --frozen-lockfile(workspace deps for the docs generator)pnpm run docs:check— the docs-check CI gate; regenerates README.md + docs/index.html regions from catalog.yaml and fails on drift (passed)Negative test: temporarily removed theaxi-axientry from catalog.yaml and re-rannode scripts/generate-docs.mjs --check— failed with drift on both README.md and docs/index.html (exit 1), then restored catalog.yaml and re-ran the check (passed,git statusclean)pnpm run docs:test(node --test scripts/generate-docs.test.mjs) — generator escaping/link/pipe helpersManual render: serveddocs/at http://127.0.0.1:8731 and loaded index.html in Chrome; asserted the rendered row cells and link href via DOM read, then captured screenshots of the community catalog tablecurl -L https://github.com/CodyEngel/axi-axi— catalog link resolves (HTTP 200)Inspected the generatedgenerated:catalog-communityregion of README.md to confirm the axi-axi row is present in the committed markdown table✅ **Document** - passed
✅ No issues found.
✅ **Lint** - passed
✅ No issues found.
✅ **Push** - passed
✅ No issues found.